home *** CD-ROM | disk | FTP | other *** search
/ PsL Monthly 1993 December / PSL Monthly Shareware CD-ROM (December 1993).iso / prgmming / dos / basic / basicxr.exe / BASICXR.DOC < prev    next >
Text File  |  1992-04-26  |  12KB  |  317 lines
  1.                      BasicXR Cross Reference Utility            v 1.2
  2.                          <c> 1991  JNGoodale
  3.                         _______
  4.                    ____|__     |                (R)
  5.                 --|       |    |-------------------
  6.                   |   ____|__  |  Association of
  7.                   |  |       |_|  Shareware
  8.                   |__|   o   |    Professionals
  9.                 -----|   |   |---------------------
  10.                      |___|___|    MEMBER
  11.  
  12.  
  13.     Files included in BASXRF.EXE:
  14.  
  15.                     BASICXR.COM     Executable program
  16.                     BASICXR.DOC     This file
  17.                     BASICXRW.XXT    Starter file for Custom Res Words
  18.                     REGISTER.DOC    Registration form
  19.                     README.TXT      Brief documentation
  20.     -------------------------------------------------------------------------
  21.     This document covers the following:
  22.  
  23.             1.  General description
  24.             2.  Start-up
  25.             3.  Printer control codes
  26.             4.  Printing to a file
  27.             5.  Forcing a page eject
  28.             6.  Creating a file of Reserved Words
  29.             7.  Requirements/Limitations
  30.             8.  Error messages
  31.             9.  Support
  32.            10.  Registration
  33.            11.  Shareware Concept/Ombudsman information
  34.  
  35.     ====================================================================
  36.  
  37.     1.  GENERAL DESCRIPTION
  38.  
  39.         This program will cross reference a program written in Basic
  40.         and saved as an ASCII file.  It will create any combination
  41.         of the following three options:
  42.  
  43.                     Formatted program listing
  44.                     User label/line number and variable cross reference
  45.                     Reserved word cross reference
  46.  
  47.         BASICXR.COM is the un-registered version and displays a
  48.         registration reminder each time it is run.
  49.  
  50.         The registered version functions identically, but the registration 
  51.         reminder is removed and it is about  5K shorter.  You receive this 
  52.         version when you register.
  53.  
  54.                                Page 1 of 5
  55.  
  56.  
  57.  
  58.     2.  START-UP
  59.  
  60.         To execute the program, simply enter BASICXR followed optionally 
  61.         by "/ switches", as described below:
  62.  
  63.                 BASICXR/M  will force the program to monochrome display.
  64.  
  65.                 BASICXR/E  will send printer control codes for Epson
  66.                            compatible printers.  See # 3 below.
  67.  
  68.                 BASICXR/D  will send printer control codes for DeskJet
  69.                            compatible printers.  See # 3 below.
  70.  
  71.         The "/M" switch can be used in conjunction with either of the
  72.         printer switches.  Order and case are not important.
  73.  
  74.  
  75.     3.  PRINTER CONTROL CODES
  76.  
  77.         If you elect to print compressed pitch for either an Epson or
  78.         DeskJet compatible printer, start the program with the
  79.         appropriate switch (/E or /D).  The program will send the
  80.         following printer control codes to your printer (or to the
  81.         output file, if you elect to output to a file for later printing):
  82.  
  83.                                 /D (DeskJet)            /E (Epson)
  84.  
  85.                 Reset           CHR$(27);"E"            CHR$(27);"@"
  86.                 Compressed      CHR$(27);"(s16.67H"     CHR$(15)
  87.  
  88.                 Line width      110 characters          120 characters
  89.                 Lines/page      54                      54
  90.  
  91.         In both cases the program resets the printer at the end.
  92.  
  93.         *  If you do not execute the program with one of the printer 
  94.            switches, no control codes are sent.  Line width is 80, 
  95.            lines/page 54.
  96.  
  97.     4.  PRINTING TO A FILE
  98.  
  99.         By entering "f" or "F" at the prompt you can direct the output
  100.         to a file for later printing.  The name of the file created will
  101.         be the same base name as your input source file with an extension
  102.         of ".XRF".  It will be written to the same path as the source.
  103.  
  104.  
  105.  
  106.                                   Page  2 of 5
  107.  
  108.  
  109.  
  110.  
  111.     5.  FORCING A PAGE EJECT
  112.  
  113.         If you would like to force a page eject in the program listing,
  114.         simply insert a line with two single quotes as the only text on
  115.         the line - '' - NOT a double quote (").
  116.  
  117.         The single quote is shorthand for REM, so the two single quotes
  118.         will not affect your program, but will trigger a page eject in
  119.         BasicXR.
  120.  
  121.     6.  CREATING A FILE OF RESERVED WORDS
  122.  
  123.         BasicXR has a built in table of Microsoft QuickBasic 4.5 reserved
  124.         words.  For another dialect of Basic you can create your own set
  125.         in a file that must be called "BASICXRW.TXT".  This is simply a
  126.         text file of the reserved words.  A starter (BASICXRW.XXT) is
  127.         supplied with this program which you can use to edit to create
  128.         your own list.  It must be renamed to "BASICXRW.TXT" for it to
  129.         take effect.
  130.  
  131.         If your programs are written in Microsoft QuickBasic 4.5 you do
  132.         not need this file.
  133.  
  134.         Maximum size of BASICXRW.TXT is 400 entries.
  135.         Maximum record length for each entry is 16.
  136.  
  137.     7.  REQUIREMENTS/LIMITATIONS
  138.  
  139.         Minimum requirements to run BasicXR are:
  140.  
  141.                 IBM compatible computer
  142.                 Monochrome or color monitor
  143.                 Printer (unless printing to a file)
  144.                 DOS 2.11 or higher
  145.                 256K
  146.  
  147.         Programs to be cross-referenced must be saved in ASCII and have
  148.         the extension ".BAS".
  149.  
  150.         The program assumes Microsoft Basic dialects.  I do not guarantee
  151.         any other versions of Basic, although it might work.
  152.  
  153.         It will work with either line numbers (as in GWBasic) or line
  154.         labels (as in QuickBasic), but not both within the same program
  155.         (which QuickBasic allows for, but BasicXR doesn't).
  156.  
  157.         Customized Reserved Word file - Maximum 400 entries, Maximum
  158.         record length 16.
  159.  
  160.                                   Page  3 of 5
  161.  
  162.  
  163.  
  164.         The size of the program it can handle is based on how much main
  165.         memory you have (up to 640K) and how many references there are.
  166.         If it runs out of room for the reference table, the program
  167.         notifies you, marks the listing where referencing will stop, and
  168.         continues the listing, if that option is turned on.
  169.  
  170.         The solution at this point would be to break the program into
  171.         several parts and then run each part thru BasicXR.
  172.  
  173.     8.  ERROR MESSAGES
  174.  
  175.         The following error messages may occur:
  176.  
  177.             Bad Path entered
  178.             No *.BAS files
  179.             No options entered.  Ending
  180.             This is not an ASCII (text) file.  Ending
  181.             Reached max of 400 Reserved Words .. ignoring excess
  182.             Label reference table exceeded
  183.  
  184.         Except where "Ending" is stated, you are given the option to
  185.         [ESC] to quit or [ENTER] to try again.
  186.  
  187.     9.  SUPPORT
  188.  
  189.         Registered owners will receive free support for three months
  190.         after registration by contacting me thru US mail, CompuServe or
  191.         phone at:
  192.  
  193.                 Jane N. Goodale
  194.                 6851 Roswell Rd, Unit I-15
  195.                 Atlanta  GA  30328
  196.  
  197.                 (404)-392-0781
  198.  
  199.                 CIS PPN 71116,302
  200.  
  201.         If you find a serious program bug, you will be sent a "fixed"
  202.         program free of charge.
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.                                   Page  4 of 5
  214.  
  215.  
  216.  
  217.     10. REGISTRATION
  218.  
  219.         Registration is available for $15.  You can fill out and print
  220.         the registration form within the program BASICXR.EXE or from
  221.         the order blank "REGISTER.DOC".
  222.  
  223.         If you distribute copies of this program, please assure that
  224.         all files and documentation are present.
  225.  
  226.     11. SHAREWARE CONCEPT/OMBUDSMAN INFORMATION
  227.  
  228.         Shareware distribution gives users a chance to try software
  229.         before buying it.  If you try a Shareware program and continue
  230.